/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.matching;

import cgl.narada.event.NBEvent;
import cgl.narada.protocol.Destinations;

/**
   This interface specifies the operations that need to be supported by
   client matching trees and cluster/unit-contoller trees.
   @author Shrideep Pallickara
   $Revision$
   $Date$
*/

public interface MatchingTree {
  /** This method returns the level assocaited with this matching tree. A 
      node could be a gateway at multiple levels. How it handles destinations
      at different levels, and propagates destinations at different levels is
      dicatated by the level of the matching tree which computes the 
      destinations and initiates profile propagation changes.
      @return The level of the matching tree.*/
  public int getMatchingLevel();

  /** This method sets the destination address for this node */
  public void setNodeDestination(Destinations destination);

  /** This method adds a subscription profile to the matching tree 
      @param profile The profile comprising the subscription and
      the destination assocaited with the subscription.  */  
  public void addSubscriptionProfile(Profile profile); 

  /** This method adds a subscription profile to the matching tree */
  public void removeSubscriptionProfile(Profile profile);

  /** Propagates profile changes to higher levels */
  public void propagateChangesToHigherLevels(Profile profile, 
					     boolean addProfile);

  public Object matchEvent(NBEvent nbEvent);

  /** Returns the type of profiles managed by this matching engine */
  public int getManagedProfileType();
}
